| Functions Summary | |
|---|---|
| bool | cot_config_add(string name, array options, mixed is_module, string category, string donor) Registers a set of configuration entries at once. |
| int | cot_config_implant(string module_name, array options, bool into_struct, string donor) Implants given options into module configuration if they are not already there. |
| bool | cot_config_implanted(string acceptor, string donor) Checks if there are already implanted config records |
| mixed | cot_config_import(string|array name, string source, string filter, string defvalue) Imports data for config values from outer world |
| string | cot_config_input(array cfg_var) Returns config input |
| array | cot_config_list(string Owner, string Extension, string category, mixed owner, mixed cat, str subcat) Get configs from database |
| array | cot_config_load(string name, mixed is_module, string category, string donor) Loads config structure from database into an array |
| int | cot_config_modify(string name, array options, mixed is_module, string category, string donor) Updates config map properties in the database for given options |
| array | cot_config_parse(array info_cfg) Parses array of setup file configuration entries into array representation |
| int | cot_config_remove(string name, mixed is_module, mixed option, string category, string donor) Unregisters configuration option(s). |
| int | cot_config_reset(string name, string option, mixed is_module, string category) Reset configuration value |
| array | cot_config_selecttitles(string name, array params) Helper function that generates selection titles. |
| int | cot_config_set(string name, array options, mixed is_module, string category) Updates configuration values Example: $config_values = array( 'disable_test' => '0', 'hidden_test' => 'test45', ); cot_config_set('test', $config_values, true); |
| array | cot_config_titles(string name, string text) Returns option title and hint |
| int|NULL | cot_config_type_int_filter(string new_value, array cfg_var, string min, string max, bool skip_warnings) Filters value as Integer in range from Min and Max. |
| int | cot_config_update(string name, array options, bool is_module, string category, string donor) Updates existing configuration map removing obsolete options, adding new options and tweaking options which need to be updated. |
| boolean|number | cot_config_update_options(string name, array optionslist, mixed is_module, string update_new_only, string source) Saves updated values of config list in DB |
public bool cot_config_add(string name, array options, mixed is_module, string category, string donor)
$config_options = array(
array(
'name' => 'disable_test',
'type' => COT_CONFIG_TYPE_RADIO,
'default' => '0'
),
array(
'name' => 'test_selection',
'type' => COT_CONFIG_TYPE_SELECT,
'default' => '20',
'variants' => '5,10,15,20,25,30,35,40,50'
),
array(
'name' => 'test_value',
'type' => COT_CONFIG_TYPE_STRING,
'default' => 'something'
),
array(
'name' => 'not_visible',
'type' => COT_CONFIG_TYPE_HIDDEN,
'default' => 'test23'
)
);
cot_config_add('test', $config_options, 'module');
public int cot_config_implant(string module_name, array options, bool into_struct, string donor)
public bool cot_config_implanted(string acceptor, string donor)
public mixed cot_config_import(string|array name, string source, string filter, string defvalue)
public string cot_config_input(array cfg_var)
public array cot_config_list(string Owner, string Extension, string category, mixed owner, mixed cat, str subcat)
public array cot_config_load(string name, mixed is_module, string category, string donor)
public int cot_config_modify(string name, array options, mixed is_module, string category, string donor)
public array cot_config_parse(array info_cfg)
public int cot_config_remove(string name, mixed is_module, mixed option, string category, string donor)
public int cot_config_reset(string name, string option, mixed is_module, string category)
public array cot_config_selecttitles(string name, array params)
public int cot_config_set(string name, array options, mixed is_module, string category)
$config_values = array(
'disable_test' => '0',
'hidden_test' => 'test45',
);
cot_config_set('test', $config_values, true);
public array cot_config_titles(string name, string text)
public int|NULL cot_config_type_int_filter(string new_value, array cfg_var, string min, string max, bool skip_warnings)
public int cot_config_update(string name, array options, bool is_module, string category, string donor)
public boolean|number cot_config_update_options(string name, array optionslist, mixed is_module, string update_new_only, string source)